ArcPad Map File Schema
FORM Element
See Also Send comments on this topic.

ArcPad Map File Schema : FORM Element

Glossary Item Box

Description

Used to define an ArcPad form.

Diagram

Overview

FORM

Used to define an ArcPad form.

height required Restriction of xs:int

width required Restriction of xs:int

backgroundcolor optional xs:string

caption optional xs:string

Displayed in the toolbar.

color optional xs:string

font optional xs:string

Font name. The name is case sensitive. If font name uses "&", use "&" instead. For example, ESRI Transportation & Civic should be written as ESRI Transportation & Civic.

fontsize optional Restriction of xs:int

Font size.

fontstyle optional Restriction of xs:string

Font style. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline")

name optional xs:string

When parent is ToolButton:

Custom tool name. Used to reference the tool in scripts.

oncancel optional xs:string

Specify the script to run when this event occurs.

onkillactive optional xs:string

Specify the script to run when this event occurs.

onload optional xs:string

Specify the script to run when this event occurs.

onok optional xs:string

Specify the script to run when this event occurs.

onrefresh optional xs:string

Specify the script to run when this event occurs.

onsetactive optional xs:string

Specify the script to run when this event occurs.

onunload optional xs:string

Specify the script to run when this event occurs.

tabsvisible optional Restriction of xs:string

sip optional Restriction of xs:string

Sequence

PAGE 1..∞

Used to define a page of an ArcPad form.

Attributes

Name	Type	Use	Default	Fixed	Description
height	Restriction of xs:int	required
width	Restriction of xs:int	required
backgroundcolor	xs:string	optional
caption	xs:string	optional			Displayed in the toolbar.
color	xs:string	optional
font	xs:string	optional			Font name. The name is case sensitive. If font name uses "&", use "&" instead. For example, ESRI Transportation & Civic should be written as ESRI Transportation & Civic.
fontsize	Restriction of xs:int	optional			Font size.
fontstyle	Restriction of xs:string	optional	regular		Font style. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline")
name	xs:string	optional			When parent is ToolButton: Custom tool name. Used to reference the tool in scripts.
oncancel	xs:string	optional			Specify the script to run when this event occurs.
onkillactive	xs:string	optional			Specify the script to run when this event occurs.
onload	xs:string	optional			Specify the script to run when this event occurs.
onok	xs:string	optional			Specify the script to run when this event occurs.
onrefresh	xs:string	optional			Specify the script to run when this event occurs.
onsetactive	xs:string	optional			Specify the script to run when this event occurs.
onunload	xs:string	optional			Specify the script to run when this event occurs.
tabsvisible	Restriction of xs:string	optional	true
sip	Restriction of xs:string	optional

Examples

ArcPad applet file (*.apa) with a form.

Source

<xs:element name="FORM" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Used to define an ArcPad form.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="PAGE" maxOccurs="unbounded" />
    </xs:sequence>
    <xs:attribute use="required" ref="height">
      <xs:annotation>
        <xs:documentation>Form height.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" ref="width">
      <xs:annotation>
        <xs:documentation>Form width.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="backgroundcolor">
      <xs:annotation>
        <xs:documentation>The background color to use for the form. This can be overridden by setting a page's or control's backgroundcolor attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="caption">
      <xs:annotation>
        <xs:documentation>Displayed in the titlebar of the form.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="color">
      <xs:annotation>
        <xs:documentation>The color to use for the form's text. This can be overridden by setting a page's or control's color attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="font">
      <xs:annotation>
        <xs:documentation>The font for the form. This can be overridden by setting a page's or control's font attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="fontsize">
      <xs:annotation>
        <xs:documentation>The font size for the form. This can be overridden by setting a page's or control's fontsize attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="regular" ref="fontstyle">
      <xs:annotation>
        <xs:documentation>The font style for the form. This can be overridden by setting a page's or control's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="name">
      <xs:annotation>
        <xs:documentation>Form name. Used when referencing the form in scripts.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="oncancel">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onkillactive">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onload">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onok">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onrefresh" />
    <xs:attribute ref="onsetactive">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="onunload">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="tabsvisible" />
    <xs:attribute default="auto" ref="sip">
      <xs:annotation>
        <xs:documentation>Specifies whether the SIP (soft input panel) is displayed on pen devices by default when controls get the focus. Individual pages can override this setting with the sip attribute of the PAGE element.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also

ArcPad Map File Schema

© 2012 All Rights Reserved.